Schemat bigApi.v1
Typ złożony RequestMessage
Schemat bigApi.v1 : Typ złożony RequestMessage
Opis
Żądanie
Typ reprezentujący żądanie wywołania wskazanej operacji BIG API.
Request message
Type representing request to call the specified BIG API operation.
Przestrzeń nazw http://api.big.pl/bigApi/v1/types
Diagram
Element data Element testDataMarker Element customProtocol Element protocol Choice Element requestDateTime Element requestId Sequence Typ złożony RequestMessage
Overview
RequestMessage
Żądanie
Typ reprezentujący żądanie wywołania wskazanej operacji BIG API.
Request message
Type representing request to call the specified BIG API operation.
Sequence
requestId Typ prosty messageId
Identyfikator żądania
Ciąg znaków identyfikujący komunikat żądania. Nadawany przez system subskrybenta, powinien jednoznacznie identyfikować żądanie w zbiorze żądań przekazanych przez subskrybenta.
Request id
String uniquely identifying the request. Given by the subscriber.
requestDateTime xs:dateTime
Data i czas przesłania żądania
Request date and time
Choice
protocol Typ prosty protocolEnum
Protokół
Wskazanie wybranego protokołu wymiany danych z użyciem BIG API. Przekazywane w ramach żądania dane muszą być zgodne z wybranym protokołem. Protokoły są opisane w osobnych schematach i specyfikacjach.
Protocol
Indication of the selected data exchange protocol to use with BIG API.
customProtocol xs:string
Dedykowany protokół
Wskazanie innego protokołu wymiany danych z użyciem BIG API. Protokół spoza standardowej listy może być użyty w uzgodnieniu z BIG InfoMonitor.
Custom protocol
Indication of the custom data exchange protocol to use with BIG API. Custom protocol can be indicated only in agreement with BIG IM.
testDataMarker xs:boolean
32214
33214
22214
23214
70214
71214
74214
75214
34214
35214
Znacznik danych testowych
Znacznik logiczny określający, czy komunikat zawiera dane fikcyjne przeznaczone do testów (różnego rodzaju) czy rzeczywiste dane. Pole to zmniejsza ryzyko pomyłkowego wprowadzeniem do systemu produkcyjnego danych przekazanych w celach testowych (np. w sytuacji zmian w oprogramowaniu u subskrybentów). Dane z przypisaną wartością logiczną "prawda" nie zostaną wprowadzone do systemu produkcyjnego BIG InfoMonitor.
Test data marker
Logical value that specifies whether the message contains fictitious data intended for testing or actual data. This field reduces the risk of introduction test data to the production system. Data with a "true" logical value assigned will not be accepted by production system.
data xs:string
Dane żądania
Dane przesyłane w ramach żądania do SIBIG. Muszą być zgodne ze specyfikacją wybranego protokołu (@RequestMessage/protocol).
Request data
Data submitted as a request to SIBIG. They must conform to the specification of the selected protocol (@RequestMessage/protocol).
Używany przez
Element updateEconomicInformationRequest
Element getReportRequest
Element updateLiabilityRequest
Element getStatisticRequest
Element checkAppStatusRequest
Element updateMonitoringRequest
Element removeTracedEventsRequest
Element getMonitoredEntitiesRequest
Element getTracedEventsRequest
Element whoMonitorsMeRequest
Element addOrderRequest
Element getOrderListRequest
Element getOrderStatusRequest
Źródło
<xs:complexType name="RequestMessage" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Żądanie</div>
      <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Typ reprezentujący żądanie wywołania wskazanej operacji BIG API.</div>
      <div class="nazwa en-GB" xmlns="http://www.w3.org/1999/xhtml">Request message</div>
      <div class="opis en-GB" xmlns="http://www.w3.org/1999/xhtml">Type representing request to call the specified BIG API operation.</div>
    </xs:documentation>
  </xs:annotation>
  <xs:sequence>
    <xs:element name="requestId" type="ba:messageId">
      <xs:annotation>
        <xs:documentation>
          <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Identyfikator żądania</div>
          <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Ciąg znaków identyfikujący komunikat żądania. Nadawany przez system subskrybenta, powinien jednoznacznie identyfikować żądanie w zbiorze żądań przekazanych przez subskrybenta.</div>
          <div class="nazwa en-GB" xmlns="http://www.w3.org/1999/xhtml">Request id</div>
          <div class="opis en-GB" xmlns="http://www.w3.org/1999/xhtml">String uniquely identifying the request. Given by the subscriber.</div>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="requestDateTime" type="xs:dateTime">
      <xs:annotation>
        <xs:documentation>
          <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Data i czas przesłania żądania</div>
          <div class="nazwa en-GB" xmlns="http://www.w3.org/1999/xhtml">Request date and time</div>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:choice>
      <xs:element name="protocol" type="ba:protocolEnum">
        <xs:annotation>
          <xs:documentation>
            <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Protokół</div>
            <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Wskazanie wybranego protokołu wymiany danych z użyciem BIG API. Przekazywane w ramach żądania dane muszą być zgodne z wybranym protokołem. Protokoły są opisane w osobnych schematach i specyfikacjach.</div>
            <div class="nazwa en-GB" xmlns="http://www.w3.org/1999/xhtml">Protocol</div>
            <div class="opis en-GB" xmlns="http://www.w3.org/1999/xhtml">Indication of the selected data exchange protocol to use with BIG API.</div>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="customProtocol" type="xs:string">
        <xs:annotation>
          <xs:documentation>
            <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Dedykowany protokół</div>
            <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Wskazanie innego protokołu wymiany danych z użyciem BIG API. Protokół spoza standardowej listy może być użyty w uzgodnieniu z BIG InfoMonitor.</div>
            <div class="nazwa en-GB" xmlns="http://www.w3.org/1999/xhtml">Custom protocol</div>
            <div class="opis en-GB" xmlns="http://www.w3.org/1999/xhtml">Indication of the custom data exchange protocol to use with BIG API. Custom protocol can be indicated only in agreement with BIG IM.</div>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:choice>
    <xs:element name="testDataMarker" type="xs:boolean">
      <xs:annotation>
        <xs:documentation>
          <div class="pole" xmlns="http://www.w3.org/1999/xhtml">32214</div>
          <div class="pole" xmlns="http://www.w3.org/1999/xhtml">33214</div>
          <div class="pole" xmlns="http://www.w3.org/1999/xhtml">22214</div>
          <div class="pole" xmlns="http://www.w3.org/1999/xhtml">23214</div>
          <div class="pole" xmlns="http://www.w3.org/1999/xhtml">70214</div>
          <div class="pole" xmlns="http://www.w3.org/1999/xhtml">71214</div>
          <div class="pole" xmlns="http://www.w3.org/1999/xhtml">74214</div>
          <div class="pole" xmlns="http://www.w3.org/1999/xhtml">75214</div>
          <div class="pole" xmlns="http://www.w3.org/1999/xhtml">34214</div>
          <div class="pole" xmlns="http://www.w3.org/1999/xhtml">35214</div>
          <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Znacznik danych testowych</div>
          <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Znacznik logiczny określający, czy komunikat zawiera dane fikcyjne przeznaczone do testów (różnego rodzaju) czy rzeczywiste dane. Pole to zmniejsza ryzyko pomyłkowego wprowadzeniem do systemu produkcyjnego danych przekazanych w celach testowych (np. w sytuacji zmian w oprogramowaniu u subskrybentów). Dane z przypisaną wartością logiczną "prawda" nie zostaną wprowadzone do systemu produkcyjnego BIG InfoMonitor.</div>
          <div class="nazwa en-GB" xmlns="http://www.w3.org/1999/xhtml">Test data marker</div>
          <div class="opis en-GB" xmlns="http://www.w3.org/1999/xhtml">Logical value that specifies whether the message contains fictitious data intended for testing or actual data. This field reduces the risk of introduction test data to the production system. Data with a "true" logical value assigned will not be accepted by production system.</div>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="data" type="xs:string">
      <xs:annotation>
        <xs:documentation>
          <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Dane żądania</div>
          <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Dane przesyłane w ramach żądania do SIBIG. Muszą być zgodne ze specyfikacją wybranego protokołu (@RequestMessage/protocol).</div>
          <div class="nazwa en-GB" xmlns="http://www.w3.org/1999/xhtml">Request data</div>
          <div class="opis en-GB" xmlns="http://www.w3.org/1999/xhtml">Data submitted as a request to SIBIG. They must conform to the specification of the selected protocol (@RequestMessage/protocol).</div>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
</xs:complexType>
Zobacz także
Schemat bigApi.v1